<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_letterbox: V_letterbox_v1_0</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_letterbox
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__v__letterbox__v1__0.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">V_letterbox_v1_0</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Letterbox Layer 2 data.  <a href="struct_x_v___lbox__l2.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga33b25a82f306f08a98a30e43d89d8962"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__letterbox__v1__0.html#ga33b25a82f306f08a98a30e43d89d8962">XLboxColorId</a> <tr class="memdesc:ga33b25a82f306f08a98a30e43d89d8962"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains the different background colors available.  <a href="group__v__letterbox__v1__0.html#ga33b25a82f306f08a98a30e43d89d8962">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ga33b25a82f306f08a98a30e43d89d8962"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gab67b61c440e54ca045781ebc6a1ea4d1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__letterbox__v1__0.html#gab67b61c440e54ca045781ebc6a1ea4d1">XV_LBoxInitialize</a> (<a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="memdesc:gab67b61c440e54ca045781ebc6a1ea4d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the core instance.  <a href="#gab67b61c440e54ca045781ebc6a1ea4d1">More...</a><br /></td></tr>
<tr class="separator:gab67b61c440e54ca045781ebc6a1ea4d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga030b5db3e6b42aa3c357b211b20c3892"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__letterbox__v1__0.html#ga030b5db3e6b42aa3c357b211b20c3892">XV_LBoxStart</a> (<a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga030b5db3e6b42aa3c357b211b20c3892"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function starts the letter box core.  <a href="#ga030b5db3e6b42aa3c357b211b20c3892">More...</a><br /></td></tr>
<tr class="separator:ga030b5db3e6b42aa3c357b211b20c3892"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga96dee5cf9bb0613427718fc6290f5a9d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__letterbox__v1__0.html#ga96dee5cf9bb0613427718fc6290f5a9d">XV_LBoxStop</a> (<a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga96dee5cf9bb0613427718fc6290f5a9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function stops the letter box core.  <a href="#ga96dee5cf9bb0613427718fc6290f5a9d">More...</a><br /></td></tr>
<tr class="separator:ga96dee5cf9bb0613427718fc6290f5a9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga361ab0bafe3ff60db1597d56be1175e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__letterbox__v1__0.html#ga361ab0bafe3ff60db1597d56be1175e1">XV_LBoxSetActiveWin</a> (<a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *InstancePtr, XVidC_VideoWindow *ActiveWindow, u32 FrameWidth, u32 FrameHeight)</td></tr>
<tr class="memdesc:ga361ab0bafe3ff60db1597d56be1175e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the letterbox active window.  <a href="#ga361ab0bafe3ff60db1597d56be1175e1">More...</a><br /></td></tr>
<tr class="separator:ga361ab0bafe3ff60db1597d56be1175e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaee1542cd7bab3fd77a0c2bc9cad721cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__letterbox__v1__0.html#gaee1542cd7bab3fd77a0c2bc9cad721cb">XV_LboxSetBackgroundColor</a> (<a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *InstancePtr, <a class="el" href="group__v__letterbox__v1__0.html#ga33b25a82f306f08a98a30e43d89d8962">XLboxColorId</a> ColorId, XVidC_ColorFormat cfmt, XVidC_ColorDepth bpc)</td></tr>
<tr class="memdesc:gaee1542cd7bab3fd77a0c2bc9cad721cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the background color to be painted outside active window.  <a href="#gaee1542cd7bab3fd77a0c2bc9cad721cb">More...</a><br /></td></tr>
<tr class="separator:gaee1542cd7bab3fd77a0c2bc9cad721cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabe5aadfb6c0a89a900d85917f0c6fc2b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__letterbox__v1__0.html#gabe5aadfb6c0a89a900d85917f0c6fc2b">XV_LBoxDbgReportStatus</a> (<a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:gabe5aadfb6c0a89a900d85917f0c6fc2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function prints LBox IP status on the console.  <a href="#gabe5aadfb6c0a89a900d85917f0c6fc2b">More...</a><br /></td></tr>
<tr class="separator:gabe5aadfb6c0a89a900d85917f0c6fc2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga33b25a82f306f08a98a30e43d89d8962"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga33b25a82f306f08a98a30e43d89d8962">&#9670;&nbsp;</a></span>XLboxColorId</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__letterbox__v1__0.html#ga33b25a82f306f08a98a30e43d89d8962">XLboxColorId</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__letterbox__l2_8h.html">xv_letterbox_l2.h</a>&gt;</code></p>

<p>This typedef contains the different background colors available. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gabe5aadfb6c0a89a900d85917f0c6fc2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabe5aadfb6c0a89a900d85917f0c6fc2b">&#9670;&nbsp;</a></span>XV_LBoxDbgReportStatus()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_LBoxDbgReportStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__letterbox__l2_8c.html">xv_letterbox_l2.c</a>&gt;</code></p>

<p>This function prints LBox IP status on the console. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the pointer to the core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p class="reference">References <a class="el" href="struct_x_v__letterbox___config.html#a41ec1d7ad33727a7a3004cda8782f124">XV_letterbox_Config::BaseAddress</a>, and <a class="el" href="struct_x_v__letterbox.html#a892b5dc48c3aff2ea82743e407acbd64">XV_letterbox::Config</a>.</p>

</div>
</div>
<a id="gab67b61c440e54ca045781ebc6a1ea4d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab67b61c440e54ca045781ebc6a1ea4d1">&#9670;&nbsp;</a></span>XV_LBoxInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XV_LBoxInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__letterbox__l2_8c.html">xv_letterbox_l2.c</a>&gt;</code></p>

<p>This function initializes the core instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is instance id of the core</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if device is found and initialized XST_DEVICE_NOT_FOUND if device is not found </dd></dl>

</div>
</div>
<a id="ga361ab0bafe3ff60db1597d56be1175e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga361ab0bafe3ff60db1597d56be1175e1">&#9670;&nbsp;</a></span>XV_LBoxSetActiveWin()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_LBoxSetActiveWin </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_VideoWindow *&#160;</td>
          <td class="paramname"><em>ActiveWindow</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>FrameWidth</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>FrameHeight</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__letterbox__l2_8c.html">xv_letterbox_l2.c</a>&gt;</code></p>

<p>This function configures the letterbox active window. </p>
<p>All pixels within the window are passed to the output as-is. Any pixel outside the defined window will be clamped to the programmed background color</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">ActiveWindow</td><td>is structure that contains window coordinates and size </td></tr>
    <tr><td class="paramname">FrameWidth</td><td>is the input stream width </td></tr>
    <tr><td class="paramname">FrameHeight</td><td>is the input stream height</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a id="gaee1542cd7bab3fd77a0c2bc9cad721cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaee1542cd7bab3fd77a0c2bc9cad721cb">&#9670;&nbsp;</a></span>XV_LboxSetBackgroundColor()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_LboxSetBackgroundColor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__v__letterbox__v1__0.html#ga33b25a82f306f08a98a30e43d89d8962">XLboxColorId</a>&#160;</td>
          <td class="paramname"><em>ColorId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorFormat&#160;</td>
          <td class="paramname"><em>cfmt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorDepth&#160;</td>
          <td class="paramname"><em>bpc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__letterbox__l2_8c.html">xv_letterbox_l2.c</a>&gt;</code></p>

<p>This function configures the background color to be painted outside active window. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">ColorId</td><td>is the background color requested </td></tr>
    <tr><td class="paramname">cfmt</td><td>is the color format of the input stream </td></tr>
    <tr><td class="paramname">bpc</td><td>is the color depth (bits per channel)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a id="ga030b5db3e6b42aa3c357b211b20c3892"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga030b5db3e6b42aa3c357b211b20c3892">&#9670;&nbsp;</a></span>XV_LBoxStart()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_LBoxStart </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__letterbox__l2_8c.html">xv_letterbox_l2.c</a>&gt;</code></p>

<p>This function starts the letter box core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a id="ga96dee5cf9bb0613427718fc6290f5a9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga96dee5cf9bb0613427718fc6290f5a9d">&#9670;&nbsp;</a></span>XV_LBoxStop()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_LBoxStop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___lbox__l2.html">XV_Lbox_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p><code>#include &lt;<a class="el" href="xv__letterbox__l2_8c.html">xv_letterbox_l2.c</a>&gt;</code></p>

<p>This function stops the letter box core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
